<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Class bmqa::ConfirmEventBuilder</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="bdedox.css" rel="stylesheet" type="text/css"/>
    <style>
      div.hanging {
        padding-left: 0.75in;
        text-indent: -0.50in;
      }
      div.unhanging {
        text-indent:     0in;
      }
      a.glossary {
        font-weight: bold;
        font-style: italic;
      }
    </style>
</head>
<!--
<body onload='searchBox.OnSelectItem(0);'>
-->
<body>

<table border=2 cellspacing=0 cellpadding=0 align=center>
<tr>
 <td valign=top align=center>
 <p align=center><b><i>Quick Links:</i></b></p>
 </td>
 <td valign=top align=center>
 <p align=center>
<a class="qindex" href="group__bmqa.html" target="_blank">bmqa</a> | <a class="qindex" href="group__bmqpi.html" target="_blank">bmqpi</a> | <a class="qindex" href="group__bmqt.html" target="_blank">bmqt</a>
 </td>
 </tr>
 </table>

  </div>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul class="tablist">
      <li><a href="components.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="components.html"><span>Components</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath">
    <ul>
      <li><a class="el" href="namespacebmqa.html">bmqa</a>      </li>
      <li><a class="el" href="classbmqa_1_1ConfirmEventBuilder.html">bmqa::ConfirmEventBuilder</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<h1>bmqa::ConfirmEventBuilder Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="bmqa::ConfirmEventBuilder" -->
<p><code>#include &lt;<a class="el" href="bmqa__confirmeventbuilder_8h_source.html">bmqa_confirmeventbuilder.h</a>&gt;</code></p>

<p><a href="classbmqa_1_1ConfirmEventBuilder-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1ConfirmEventBuilder.html#a88005d0cc3e8a2dee6aa3d5f83924414">ConfirmEventBuilder</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1ConfirmEventBuilder.html#a8d8a7b115b6b095330893ad0ef93199c">~ConfirmEventBuilder</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbmqt_1_1EventBuilderResult.html#a04d8f1ec70faff7c9dce79d82c14844c">bmqt::EventBuilderResult::Enum</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1ConfirmEventBuilder.html#a29309e053c41d827949ec7c4e0e1fbaf">addMessageConfirmation</a> (const <a class="el" href="classbmqa_1_1Message.html">Message</a> &amp;message)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbmqt_1_1EventBuilderResult.html#a04d8f1ec70faff7c9dce79d82c14844c">bmqt::EventBuilderResult::Enum</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1ConfirmEventBuilder.html#a40809d42421588eeaae7ff843c653b73">addMessageConfirmation</a> (const <a class="el" href="classbmqa_1_1MessageConfirmationCookie.html">MessageConfirmationCookie</a> &amp;cookie)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1ConfirmEventBuilder.html#a9479afff4bcb0033a9efefa678089ce4">reset</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1ConfirmEventBuilder.html#aabd0134cd8983b0ae129926095d40e0c">messageCount</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const bdlbb::Blob &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1ConfirmEventBuilder.html#a244fc87f8ae4dfbb19ad314e7112cf6d">blob</a> () const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Mechanism to build a batch of CONFIRM messages.</p>
<p>See <a class="el" href="group__bmqa__confirmeventbuilder.html">Component bmqa_confirmeventbuilder</a> </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a88005d0cc3e8a2dee6aa3d5f83924414"></a><!-- doxytag: member="bmqa::ConfirmEventBuilder::ConfirmEventBuilder" ref="a88005d0cc3e8a2dee6aa3d5f83924414" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bmqa::ConfirmEventBuilder::ConfirmEventBuilder </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Create an invalid instance. Application should not create <code><a class="el" href="classbmqa_1_1ConfirmEventBuilder.html">ConfirmEventBuilder</a></code> themselves, but ask the <code><a class="el" href="classbmqa_1_1Session.html">bmqa::Session</a></code> to give them one, by using <code><a class="el" href="classbmqa_1_1Session.html#ae1308efd8c03f795c33bd4c8a48790c4">bmqa::Session::loadConfirmEventBuilder</a></code>. </p>

</div>
</div>
<a class="anchor" id="a8d8a7b115b6b095330893ad0ef93199c"></a><!-- doxytag: member="bmqa::ConfirmEventBuilder::~ConfirmEventBuilder" ref="a8d8a7b115b6b095330893ad0ef93199c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bmqa::ConfirmEventBuilder::~ConfirmEventBuilder </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Destroy this instance. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a29309e053c41d827949ec7c4e0e1fbaf"></a><!-- doxytag: member="bmqa::ConfirmEventBuilder::addMessageConfirmation" ref="a29309e053c41d827949ec7c4e0e1fbaf" args="(const Message &amp;message)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structbmqt_1_1EventBuilderResult.html#a04d8f1ec70faff7c9dce79d82c14844c">bmqt::EventBuilderResult::Enum</a> bmqa::ConfirmEventBuilder::addMessageConfirmation </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classbmqa_1_1Message.html">Message</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>message</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Append a confirmation message for the specified <code>message</code>. Return zero on success, and a non-zero value otherwise. Behavior is undefined unless this instance was obtained using <code><a class="el" href="classbmqa_1_1Session.html#ae1308efd8c03f795c33bd4c8a48790c4">bmqa::Session::loadConfirmEventBuilder</a></code>. </p>

</div>
</div>
<a class="anchor" id="a40809d42421588eeaae7ff843c653b73"></a><!-- doxytag: member="bmqa::ConfirmEventBuilder::addMessageConfirmation" ref="a40809d42421588eeaae7ff843c653b73" args="(const MessageConfirmationCookie &amp;cookie)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structbmqt_1_1EventBuilderResult.html#a04d8f1ec70faff7c9dce79d82c14844c">bmqt::EventBuilderResult::Enum</a> bmqa::ConfirmEventBuilder::addMessageConfirmation </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classbmqa_1_1MessageConfirmationCookie.html">MessageConfirmationCookie</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>cookie</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Append a confirmation message for the specified <a class="el" href="classbmqa_1_1MessageConfirmationCookie.html">MessageConfirmationCookie</a> <code>cookie</code>. Return zero on success, and a non-zero value otherwise. Behavior is undefined unless this instance was obtained using <code><a class="el" href="classbmqa_1_1Session.html#ae1308efd8c03f795c33bd4c8a48790c4">bmqa::Session::loadConfirmEventBuilder</a></code>. </p>

</div>
</div>
<a class="anchor" id="a9479afff4bcb0033a9efefa678089ce4"></a><!-- doxytag: member="bmqa::ConfirmEventBuilder::reset" ref="a9479afff4bcb0033a9efefa678089ce4" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void bmqa::ConfirmEventBuilder::reset </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Reset the builder, effectively discarding the batch of confirmation messages under construction. </p>

</div>
</div>
<a class="anchor" id="aabd0134cd8983b0ae129926095d40e0c"></a><!-- doxytag: member="bmqa::ConfirmEventBuilder::messageCount" ref="aabd0134cd8983b0ae129926095d40e0c" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int bmqa::ConfirmEventBuilder::messageCount </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the number of messages currently in the ConfirmEvent being built. Behavior is undefined unless this instance was obtained using <code><a class="el" href="classbmqa_1_1Session.html#ae1308efd8c03f795c33bd4c8a48790c4">bmqa::Session::loadConfirmEventBuilder</a></code>. </p>

</div>
</div>
<a class="anchor" id="a244fc87f8ae4dfbb19ad314e7112cf6d"></a><!-- doxytag: member="bmqa::ConfirmEventBuilder::blob" ref="a244fc87f8ae4dfbb19ad314e7112cf6d" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const bdlbb::Blob&amp; bmqa::ConfirmEventBuilder::blob </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return a reference not offering modifiable access to the blob of confirmation messages batch built by this builder. If no messages were added, this will return an empty blob, i.e., a blob with <code>length == 0</code>. Behavior is undefined unless this instance was obtained using <code><a class="el" href="classbmqa_1_1Session.html#ae1308efd8c03f795c33bd4c8a48790c4">bmqa::Session::loadConfirmEventBuilder</a></code>. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="bmqa__confirmeventbuilder_8h_source.html">bmqa_confirmeventbuilder.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Jun 15 2023 11:58:51 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
